<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Copyright 1997 The Open Group, All Rights Reserved -->

<title>tgetent</title>
</head><body bgcolor=white>
<center>
<font size=2>
The Single UNIX &reg; Specification, Version 2<br>
Copyright &copy; 1997 The Open Group

</font></center><hr size=2 noshade>
<xref type="10" name="tgetent"></xref>
<h4><a name = "tag_002_001_040">&nbsp;</a>NAME</h4><blockquote>
tgetent, tgetflag, tgetnum, tgetstr, tgoto - <b>termcap</b> database
emulation (<b>TO BE WITHDRAWN</b>)
</blockquote><h4><a name = "tag_002_001_041">&nbsp;</a>SYNOPSIS</h4><blockquote>
<pre><code>

#include &lt;<a href="term.h.html">term.h</a>&gt;

int tgetent(char *<i>bp</i>, const char *<i>name</i>);

int tgetflag(char <i>id</i>[2]);

int tgetnum(char <i>id</i>[2]);

char *tgetstr(char <i>id</i>[2], char **<i>area</i>);

char *tgoto(char *<i>cap</i>, int <i>col</i>, int <i>row</i>);
</code>
</pre>
</blockquote><h4><a name = "tag_002_001_042">&nbsp;</a>DESCRIPTION</h4><blockquote>
The
<i>tgetent()</i>
function looks up the <b>termcap</b> entry for <i>name</i>.  The emulation
ignores the buffer pointer <i>bp</i>.
<p>
The
<i>tgetflag()</i>
function gets the boolean entry for <i>id</i>.
<p>
The
<i>tgetnum()</i>
function gets the numeric entry for <i>id</i>.
<p>
The
<i>tgetstr()</i>
function gets the string entry for <i>id</i>.  If
<i>area</i>
is not a null pointer and does not point to a null pointer,
<i>tgetstr()</i>
copies the string entry into the buffer pointed to by
<i>*area</i>
and advances the variable pointed to by
<i>area</i>
to the first byte after the copy of the string entry.
<p>
The
<i>tgoto()</i>
function instantiates the parameters
<i>col</i>
and
<i>row</i>
into the capability
<i>cap</i>
and returns a pointer to the resulting string.
<p>
All of the information available
in the <b>terminfo</b> database need not be available through these functions.
</blockquote><h4><a name = "tag_002_001_043">&nbsp;</a>RETURN VALUE</h4><blockquote>
Upon successful completion, functions that return an integer return OK.
Otherwise, they return ERR.
<p>
Functions that return pointers return a null pointer on error.
</blockquote><h4><a name = "tag_002_001_044">&nbsp;</a>ERRORS</h4><blockquote>
No errors are defined.
</blockquote><h4><a name = "tag_002_001_045">&nbsp;</a>APPLICATION USAGE</h4><blockquote>
These functions are included as a conversion aid for programs that use the
<b>termcap</b> library.  Their arguments are the same and the functions are
emulated using the <b>terminfo</b> database.
<p>
These functions are only guaranteed to operate reliably on character sets in
which each character fits into a single byte, whose attributes can be
expressed using only constants with the A_ prefix.
<p>
Any terminal capabilities from the <b>terminfo</b> database that cannot be
retrieved using these interfaces can be retrieved using the interfaces
described on the
<i><a href="tigetflag.html">tigetflag()</a></i>
page.
<p>
Portable applications must use
<i><a href="tputs.html">tputs()</a></i>
to output the strings returned by
<i>tgetstr()</i>
and
<i>tgoto()</i>.
</blockquote><h4><a name = "tag_002_001_046">&nbsp;</a>SEE ALSO</h4><blockquote>
<i><a href="../xsh/putc.html">putc()</a></i>,
<i><a href="setupterm.html">setupterm()</a></i>,
<i><a href="tigetflag.html">tigetflag()</a></i>,
<i><a href="term.h.html">&lt;term.h&gt;</a></i>.
</blockquote><hr size=2 noshade>
<center><font size=2>
UNIX &reg; is a registered Trademark of The Open Group.<br>
Copyright &copy; 1997 The Open Group
<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]

</font></center><hr size=2 noshade>
</body></html>
